home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / man3 / CrtTrace.3 < prev    next >
Text File  |  1994-09-20  |  9KB  |  307 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/CrtTrace.3,v 1.8 93/04/01 09:25:26 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS Tcl_CreateTrace tclc
  206. .BS
  207. .SH NAME
  208. Tcl_CreateTrace, Tcl_DeleteTrace \- arrange for command execution to be traced
  209. .SH SYNOPSIS
  210. .nf
  211. \fB#include <tcl.h>\fR
  212. .sp
  213. Tcl_Trace
  214. \fBTcl_CreateTrace\fR(\fIinterp, level, proc, clientData\fR)
  215. .sp
  216. \fBTcl_DeleteTrace\fR(\fIinterp, trace\fR)
  217. .SH ARGUMENTS
  218. .AS Tcl_CmdTraceProc (clientData)()
  219. .AP Tcl_Interp *interp in
  220. Interpreter containing command to be traced or untraced.
  221. .AP int level in
  222. Only commands at or below this nesting level will be traced.  1 means
  223. top-level commands only, 2 means top-level commands or those that are
  224. invoked as immediate consequences of executing top-level commands
  225. (procedure bodies, bracketed commands, etc.) and so on.
  226. .AP Tcl_CmdTraceProc *proc in
  227. Procedure to call for each command that's executed.  See below for
  228. details on the calling sequence.
  229. .AP ClientData clientData in
  230. Arbitrary one-word value to pass to \fIproc\fR.
  231. .AP Tcl_Trace trace in
  232. Token for trace to be removed (return value from previous call
  233. to \fBTcl_CreateTrace\fR).
  234. .BE
  235.  
  236. .SH DESCRIPTION
  237. .PP
  238. \fBTcl_CreateTrace\fR arranges for command tracing.  From now on, \fIproc\fR
  239. will be invoked before Tcl calls command procedures to process
  240. commands in \fIinterp\fR.  The return value from
  241. \fBTcl_CreateTrace\fR is a token for the trace,
  242. which may be passed to \fBTcl_DeleteTrace\fR to remove the trace.  There may
  243. be many traces in effect simultaneously for the same command interpreter.
  244. .PP
  245. \fIProc\fR should have arguments and result that match the
  246. type \fBTcl_CmdTraceProc\fR:
  247. .nf
  248. .sp
  249. .RS
  250. typedef void Tcl_CmdTraceProc(
  251. .RS
  252. ClientData \fIclientData\fR,
  253. Tcl_Interp *\fIinterp\fR,
  254. int \fIlevel\fR,
  255. char *\fIcommand\fR,
  256. Tcl_CmdProc *\fIcmdProc\fR,
  257. ClientData \fIcmdClientData\fR,
  258. int \fIargc\fR,
  259. char *\fIargv\fR[]));
  260. .sp
  261. .RE
  262. .RE
  263. .fi
  264. The \fIclientData\fP and \fIinterp\fP parameters are
  265. copies of the corresponding arguments given to \fBTcl_CreateTrace\fR.
  266. \fIClientData\fR typically points to an application-specific
  267. data structure that describes what to do when \fIproc\fR
  268. is invoked.  \fILevel\fR gives the nesting level of the command
  269. (1 for top-level commands passed to \fBTcl_Eval\fR by the application,
  270. 2 for the next-level commands passed to \fBTcl_Eval\fR as part of parsing
  271. or interpreting level-1 commands, and so on).  \fICommand\fR
  272. points to a string containing the text of the
  273. command, before any argument substitution.
  274. \fICmdProc\fR contains the address of the command procedure that
  275. will be called to process the command (i.e. the \fIproc\fR argument
  276. of some previous call to \fBTcl_CreateCommand\fR) and \fIcmdClientData\fR
  277. contains the associated client data for \fIcmdProc\fR (the \fIclientData\fR
  278. value passed to \fBTcl_CreateCommand\fR).  \fIArgc\fR and \fIargv\fR give
  279. the final argument information that will be passed to \fIcmdProc\fR, after
  280. command, variable, and backslash substitution.
  281. \fIProc\fR must not modify the \fIcommand\fR or \fIargv\fR strings.
  282. .PP
  283. Tracing will only occur for commands at nesting level less than
  284. or equal to the \fIlevel\fR parameter (i.e. the \fIlevel\fR
  285. parameter to \fIproc\fR will always be less than or equal to the
  286. \fIlevel\fR parameter to \fBTcl_CreateTrace\fR).
  287. .PP
  288. Calls to \fIproc\fR will be made by the Tcl parser immediately before
  289. it calls the command procedure for the command (\fIcmdProc\fR).  This
  290. occurs after argument parsing and substitution, so tracing for
  291. substituted commands occurs before tracing of the commands
  292. containing the substitutions.  If there is a syntax error in a
  293. command, or if there is no command procedure associated with a
  294. command name, then no tracing will occur for that command.  If a
  295. string passed to Tcl_Eval contains multiple commands (bracketed, or
  296. on different lines) then multiple calls to \fIproc\fR will occur,
  297. one for each command.  The \fIcommand\fR string for each of these
  298. trace calls will reflect only a single command, not the entire string
  299. passed to Tcl_Eval.
  300. .PP
  301. \fBTcl_DeleteTrace\fR removes a trace, so that no future calls will be
  302. made to the procedure associated with the trace.  After \fBTcl_DeleteTrace\fR
  303. returns, the caller should never again use the \fItrace\fR token.
  304.  
  305. .SH KEYWORDS
  306. command, create, delete, interpreter, trace
  307.